Formal Parameter | Type | Default | Required | Description |
appliesTo | STRING | false | This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
attributeImage | STRING | treeAttribute.gif | false | Specifies the image to use to represent an attribute object in tree. |
attributeLockedImage | STRING | treeAttributeLocked.gif | false | Specifies the image to use to represent a locked attribute object in tree. |
canCancelPrompt | BOOLEAN | true | false | Indicates whether the cancel prompt button is displayed |
contextMenus | STRING | false | This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:
|
|
cssPrefix | STRING | false | Prefix to append to all css class names. |
|
debugErrorFlags | INTEGER | 65535 | false | Indicates which extra debug information to include in case of an error. The flags are taken from the EnumWebAppDebugFlags enumeration. |
debugFlags | INTEGER | 0 | false | Indicates which debug information to include. The flags are taken from the EnumWebAppDebugFlags enumeration. |
dragMode | INTEGER | 0 | false | Indicates the drag mode that the component to render will have. Usage: This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include: |
elementImage | STRING | treeAttributeElement.gif | false | Specifies the image to use to represent an attribute's eleement object in tree. |
errorImage | STRING | promptError_white.gif | false | |
extraInput | STRING | false | Indicates any extra inputs to be included in the forms generated by the transform. |
|
extraUrl | STRING | false | Indicates any extra parameters to be included in the links generated by the transform. |
|
firstIncFecthImage | STRING | arrow_first_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the first block in incremental fetching. |
folderImage | STRING | treeFolderClosed.gif | false | Specifies the image to use to represent a folder object in tree. |
globalCssErrorMessage | STRING | error-message | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all error messages. |
globalCssErrorTitle | STRING | error-title | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all Error titles. |
height | STRING | false | Indicates the default height of the component. If this is not a resizable component, this
is the height used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |
|
hierarchyImage | STRING | hierarchy.png | false | Specifies the image to use to represent a hierarchy object in tree. |
iframeEnabled | BOOLEAN | false | false | Indicates whether the transform supports iframe manipulations. |
imgWait | STRING | ani_wait.gif | false | Deprecated. This value is not used anymore by the Transform as the wait image is included using css. Name of the image for the Processing icon on the Wait page. Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. |
indexContentPostfixImage | STRING | _olive.gif | false | Deprecated. FP not being used anymore. The name of each image on the Prompt's content must be its position and this postfix, i.e. 1 + "_white.gif". |
indexListPostfixImage | STRING | .gif | false | Deprecated. FP not being used anymore. The name of each image on the Prompt's index must be its position and this postfix, i.e. 1 + "_white.gif". |
initialIndent | INTEGER | 0 | false | Deprecated. Indentation is not appended by Transforms anymore. Indicates the initial indentation of the HTML generated. |
lastIncFecthImage | STRING | arrow_end_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the last block in incremental fetching. |
lowerCornerImage | STRING | loginLowerLeftCorner.gif | false | Deprecated. FP not being used anymore. The image for the lower corner of the frame for multi-prompted reports. As of version 8.0, these formal parameters are not directly used by the application. They are still referenced by the PromptsClassicTransform.renderPromptsContainer(MarkupOutput) method |
nextIncFecthImage | STRING | arrow_right_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the next block in incremental fetching. |
orientation | INTEGER | 2 | false | Indicates the orientation the dialog to render will have. Usage: Possible values for this property and their meaning include: |
orientationsAllowed | INTEGER | 3 | false | Indicates the orientation modes allowed for the dialog to render. Usage: Possible values for this property and their meaning include: |
previousIncFecthImage | STRING | arrow_left_inc_fetch_v.gif | false | Deprecated. FP not being used anymore. The name of the image for the previous block in incremental fetching. |
resizeLevel | INTEGER | 0 | false | Indicates whether the component can be resized vertically/horizontally or both or none.
Possible values are AbstractAppTransform.RESIZE_NONE , AbstractAppTransform.RESIZE_VERTICAL , AbstractAppTransform.RESIZE_HORIZONTAL ,
AbstractAppTransform.RESIZE_ALL |
scriptClass | STRING | false | Holds the name of the javaScript class (if any) to be associated with the component.
When the scriptClass is specified, a bone is registered on the page for this component.
A bone is the corresponding concept of a bean in Microstrategy's javascript environment. By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method. |
|
summaryImage | STRING | PromptSummary.gif | false | Deprecated. FP not being used anymore. The name of the image for displaying the summary item. |
type | STRING | false | This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
upperCornerImage | STRING | loginUpperLeftCorner.gif | false | Deprecated. FP not being used anymore. The Image for the upper corner of the frame for multi-prompted reports. As of version 8.0, these formal parameters are not directly used by the application. They are still referenced by the PromptsClassicTransform.renderPromptsContainer(MarkupOutput) method |
useDHTML | BOOLEAN | true | false | Indicates whether to use DHTML on the output. If not set, the bean's OutputFormat() method will be used. |
width | STRING | false | Indicates the default width of the component. If this is not a resizable component, this
is the width used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |